home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / include / content / nsIRadioVisitor.h < prev    next >
C/C++ Source or Header  |  2006-05-08  |  4KB  |  99 lines
  1. /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
  2.  
  3. /* ***** BEGIN LICENSE BLOCK *****
  4.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  5.  *
  6.  * The contents of this file are subject to the Mozilla Public License Version
  7.  * 1.1 (the "License"); you may not use this file except in compliance with
  8.  * the License. You may obtain a copy of the License at
  9.  * http://www.mozilla.org/MPL/
  10.  *
  11.  * Software distributed under the License is distributed on an "AS IS" basis,
  12.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13.  * for the specific language governing rights and limitations under the
  14.  * License.
  15.  *
  16.  * The Original Code is mozilla.org code.
  17.  *
  18.  * The Initial Developer of the Original Code is
  19.  * John B. Keiser
  20.  * Portions created by the Initial Developer are Copyright (C) 2001
  21.  * the Initial Developer. All Rights Reserved.
  22.  *
  23.  * Contributor(s):
  24.  *
  25.  * Alternatively, the contents of this file may be used under the terms of
  26.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28.  * in which case the provisions of the GPL or the LGPL are applicable instead
  29.  * of those above. If you wish to allow use of your version of this file only
  30.  * under the terms of either the GPL or the LGPL, and not to allow others to
  31.  * use your version of this file under the terms of the MPL, indicate your
  32.  * decision by deleting the provisions above and replace them with the notice
  33.  * and other provisions required by the GPL or the LGPL. If you do not delete
  34.  * the provisions above, a recipient may use your version of this file under
  35.  * the terms of any one of the MPL, the GPL or the LGPL.
  36.  *
  37.  * ***** END LICENSE BLOCK ***** */
  38.  
  39. #ifndef nsIRadioVisitor_h___
  40. #define nsIRadioVisitor_h___
  41.  
  42. #include "nsISupports.h"
  43. class nsIFormControl;
  44.  
  45. // IID for the nsIRadioControl interface
  46. #define NS_IRADIOVISITOR_IID \
  47. { 0xd3494bd2, 0x1dd1, 0x11b2, \
  48.   { 0xbe, 0x86, 0xb5, 0x08, 0xc8, 0x71, 0xd7, 0xc5 } }
  49.  
  50. /**
  51.  * This interface is used for the text control frame to store its value away
  52.  * into the content.
  53.  */
  54. class nsIRadioVisitor : public nsISupports {
  55. public:
  56.  
  57.   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IRADIOVISITOR_IID)
  58.  
  59.   /**
  60.    * Visit a node in the tree.  This is meant to be called on all radios in a
  61.    * group, sequentially.  (Each radio group implementor may define
  62.    * sequentially in their own way, it just has to be the same every time.)
  63.    * Currently all radio groups are ordered in the order they appear in the
  64.    * document.  Radio group implementors should honor the aStop parameter and
  65.    * stop iterating over form controls when Visit() returns true there.
  66.    *
  67.    * @param aRadio the radio button in question (must be nsnull and QI'able to
  68.    *               nsIRadioControlElement)
  69.    * @param aStop whether or not to stop iterating (out-param)
  70.    */
  71.   NS_IMETHOD Visit(nsIFormControl* aRadio, PRBool* aStop) = 0;
  72. };
  73.  
  74. /**
  75.  * This visitor sets CheckedChanged on all elements it finds.
  76.  *
  77.  * @param aVisitor the visitor (out param)
  78.  * @param aCheckedChanged the value of CheckedChanged to set on all elements
  79.  */
  80. nsresult
  81. NS_GetRadioSetCheckedChangedVisitor(PRBool aCheckedChanged,
  82.                                     nsIRadioVisitor** aVisitor);
  83.  
  84. /**
  85.  * This visitor will take the boolean you're pointing at and put
  86.  * aCheckedChanged into it.  If the visitor is never called, aCheckedChanged
  87.  * will of course not change.
  88.  *
  89.  * @param aVisitor the visitor (out param)
  90.  * @param aCheckedChanged the boolean to put CheckedChanged into
  91.  * @param aExcludeElement the element 
  92.  */
  93. nsresult
  94. NS_GetRadioGetCheckedChangedVisitor(PRBool* aCheckedChanged,
  95.                                     nsIFormControl* aExcludeElement,
  96.                                     nsIRadioVisitor** aVisitor);
  97.  
  98. #endif // nsIRadioVisitor_h___
  99.